home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 17 / CU Amiga Magazine's Super CD-ROM 17 (1997)(EMAP Images)(GB)[!][issue 1997-12].iso / CUCD / Programming / DiceSource / doc / quickref.doc < prev    next >
Text File  |  1994-02-13  |  3KB  |  92 lines
  1.  
  2. quickref/quickref                           quickref/quickref
  3.  
  4.                    QUICKREF.DOC
  5.  
  6.     NOTE:   The unregistered version of DICE does NOT have the DCC:MAN
  7.         directory.
  8.  
  9.  
  10.     DME may be used to quick-reference library calls.  To allow DME to
  11.     do this the following lines must be in your S:.EDRC file (hd installed):
  12.  
  13.     addpath dcc:man
  14.     addpath dcc:doc
  15.     addpath dinclude:
  16.  
  17.     floppy installed, you can reference the original distribution diskettes.
  18.     Note that the disk containing the reference you seek must be in a drive
  19.     or the reference will not be found.
  20.  
  21.     addpath dcc2:man
  22.     addpath dcc1:doc
  23.     addpath dinclude:
  24.  
  25.     The dcc:man directory contains manual pages for DICE and an already
  26.     created quick-reference file DME.REFS .  By adding the directory to
  27.     DME's search list you can, from DME, position the cursor over any
  28.     subroutine name, example:
  29.  
  30.         printf("%s%d\n", "fubar", 10);
  31.         ^
  32.         cursor is over the 'p'
  33.  
  34.     And type c-] (control-right-bracket), and DME will search all paths for
  35.     DME.REFS files containing quick reference info for DICE manual pages.
  36.     DME brings up a window with the appropriate reference information.    Your
  37.     original window is still available, of course, so you can refer to the
  38.     material and make changes to your program source easily.
  39.  
  40.     DME may also be used to quick-reference the AUTODOCS (obtained from
  41.     Commodore).  DME's autorefs program may be used to generate DME.REFS
  42.     files for all autodocs except dos.doc which, unfortunately, is in a
  43.     different format (I haven't had time to hack autorefs to be able to
  44.     handle dos.doc but the source to autorefs is also available to you)
  45.  
  46.     You can also quick-ref documents on executables.  For example, 'dcc' gets
  47.     you the document on the DCC front end.
  48.  
  49.     Additionally, you can quick-reference INCLUDE STRUCTURES.  That is why
  50.     the 'addpath dinclude:' is in there.  For example:
  51.  
  52.         NewWindow
  53.         ^
  54.         cursor over the N, type c-] (control right-bracket)
  55.  
  56.     Will bring up the associated structure from the includes files.  If you
  57.     have commented includes (AmigaDOS V1.3 Native Developer's Update, $20
  58.     from Commodore) you can run autorefs on those and get more wordy
  59.     quick-reference material.
  60.  
  61.     ------------------------------------------------------------------------
  62.                 HOW IT WORKS
  63.  
  64.     To create a quick-refable document the header before each 'manual' entry
  65.     must be of the form:
  66.  
  67.     aaaaa/bbbbb                         aaaaa/bbbbb
  68.  
  69.     That is, the same a/b string repeated twice on the line.  This is how
  70.     the autodocs: are formatted, by the way.  You can also quickref .H files
  71.     in which case structure definitions (but not typedefs, sorry!) will be
  72.     quick referenced.  The program that creates a quick-reference file from
  73.     a set of manual or .H files is called AUTOREFS.  The format is (example
  74.     showing how to quick-reference your includes):
  75.  
  76.     1> cd dinclude:
  77.     1> delete dme.refs        ; make sure dme.refs is gone 'cause it is appended to
  78.     1> autorefs DME.REFS #?.h amiga/#?/#?.h
  79.  
  80.     Basically you can specify arbitrary wild cards.  The files specified should
  81.     be relative the current directory.    You then add the current directory
  82.     to DME's ADDPATH list:
  83.  
  84.     (in DME's S:.EDRC file):
  85.  
  86.     addpath dinclude:
  87.  
  88.  
  89.     DME searches for a DME.REFS file in all specified path directories when
  90.     searching for a keyword.
  91.  
  92.